vcBufferProductsStatement

Buffer statement creates a temporary storage for products in a grid pattern. Multiple products can be coming in and leaving the buffer in parallel. Transport of products is handled similarly to the Transport statements. The statement continues execution until the break condition is met and the buffer has emptied.

See in: Overview

Module: vcProcessModel

Parent: vcStatement

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
BreakConditionProperty	vcExpressionProperty	R	Gets a property which defines when this expression evaluates to True (at least once), the buffer stops accepting products. See more This allows the buffer to empty and then the statement execution to end. The expression is evaluated at the start of the statement execution and every time a product arrives to or leaves the buffer. Must be from the same component.
BufferMode	vcBufferMode	RW	Gets or sets the product access order of the buffer.
Destination	vcTransportOutType	RW	Gets or sets the destination to where products leave the buffer.
DestinationContainer	vcContainer	RW	Gets or sets the component container whose output connection is used to place the outgoing products. Only used when Destination is set to vcTransportOutType.CONTAINER.
DestinationTransportNode	vcTransportNode	RW	Gets or sets the destination transport node. Only used when Destination is set to vcTransportOutType.TRANSPORT_NODE.
Filter	vcProductFilter	R	Gets the filter.
InputResourcePositionFrame	vcFrameFeature	RW	Gets or sets the resource position offset from product position and XY plane on which resource position is projected to while emptying the buffer. See more This allows the resource position to move along with the product position but still remain on a certain plane. Must be from the same component.
Offset	vcMatrix	RW	Gets or sets the offset of the first product from product position frame.
OutputResourcePositionFrame	vcFrameFeature	RW	Gets or sets the resource position offset See more from product position and XY plane on which resource position is projected to for transport out operations.
ParallelInputLimit	Integer	RW	Gets or sets how many products can be arriving to the buffer in parallel. Must be greater than zero.
ParallelOutputLimit	Integer	RW	Gets or sets how many products can be leaving the buffer in parallel. Must be greater than zero.
PatternCount	rVector	RW	Gets or sets the number of buffer slots per X,Y,Z axis. See more The Real values of the vector are rounded to nearest Integer values. Each dimension should in inclusive range 0 to 1289.
PatternStep	vcVector	RW	Gets or sets the step between products in pattern per X,Y,Z axis.
PatternTotalCount	Integer	R	Gets the total count of patterns.
ProductPositionFrame	vcFrameFeature	RW	Gets or sets the frame defining the position and orientation of the product pattern in combination with the Offset property. Must be from the same component.
ReservedProductVariableName	String	RW	Gets or sets the name of variable containing products already reserved using Reserve Product statement. See more The buffer will be first filled using these products and then will continue to receive further products as defined by the Source property.
Source	vcTransportInType	RW	Gets or sets how products get into the buffer.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
demoteFromCombinationFilter	vcProductFilter	None	Downgrades back to filter, filter count must have 1 or 0 filters. See more Returns: vcProductFilter: The modified filter. Exceptions: TypeError: When the filter is not a CombinationFilter. TypeError: When CombinationFilter has more than 1 sub-filters.
promoteToCombinationFilter	vcProductFilter	None	Upgrades current filter to combination filter. See more Returns: vcProductFilter: The modified filter. Exceptions: TypeError: When the filter is already a CombinationFilter.
replaceFrom	vcProductFilter	vcStatement statement	Sets filter from other container. See more Parameters: statement (vcStatement): The statement to replace the filter from. Has to be a statement with a filter container. Returns: vcProductFilter: The modified filter. Exceptions: AttributeError: When argument is a statement without a filter container.
setFilter	vcProductFilter	vcProductFilterType filterType	Sets to specific filter. See more Parameters: filterType (vcProductFilterType): The type of filter to set to. Returns: vcProductFilter: The new filter. Exceptions: AttributeError: When the argument filterType is ProductType.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnFilterChanged	None	Triggered when filter is changed.